Management API

Base Resource URL:


                    https://[server-name]/api/v01/customers/[customer-id]/payment-options

Description:

Provides access to payment options associated with the specified customer.

Available sub-resources:

Resource URL	Description
https://[server-name]/api/v01/customers/[customer-id]/payment-options/[payment-option-id]	Provides access to configuration settings for the specified payment option.

Supported Actions:

create

Method: PUT	Implicit: Yes	Returns: PaymentOption *
Consumes: json, xml		Produces: json, xml

Manage payment methods that customers can use for recurring billing subscriptions. Create and maintain various payment options, including credit cards and direct debit accounts.\n\r\n> Note: Each payment option is linked to a specific customer, though customers can have multiple payment methods. Each payment option serves as a recurring funding source for subscriptions.\n\r\n> Warning: Payment options contain sensitive cardholder data. Ensure your implementation follows PCI compliance requirements when handling payment information.\n\r\n> Tip: Use tokenization to securely handle payment methods and reduce PCI DSS compliance scope. This enables you to set up recurring payments without storing sensitive payment details in your system.

Parameters:

#	Name	Type	Required	Default	Description
01	object	PaymentOption *	Yes		Payment option information associated with the merchant.

find

Method: GET	Implicit: Yes	Returns: PaymentOption[] *
Consumes: xurl		Produces: json, xml

Returns a list of available payment options associated with the specified customer.

Parameters:

#	Name	Type	Required	Default	Description
01	offset	Integer	No	0	Index of the first record returned from the search result.\n\r\n> Note: Default value is 0. Used with limit parameter for pagination.\n\r\n> Tip: Use this field for implementing paginated results. See Error Messages section for details on pagination issues.
02	limit	Integer	No	100	Maximum number of records to load per search call.\n\r\n> Note: Default value is 100. Adjust based on performance requirements.\n\r\n> Tip: Use this field to balance response size and performance. See Webhooks Management Guide for details on handling large datasets.